home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / internet / other / mail / pathalia.zoo / src / mapentry < prev    next >
Encoding:
Text File  |  1990-11-24  |  11.1 KB  |  301 lines
  1. [This is a document Rayan and I whipped up to answer some of the
  2.  queries about map entries -- hopefully, it'll reduce the number of
  3.  map entries that need to be manually corrected and fixed up.  We
  4.  would appreciate it if the old hands at the map entry game also read
  5.  this to see if we missed anything or got it wrong. - Mark.]
  6.  
  7. Introduction
  8.  
  9. The UUCP map is a database of information about hosts that communicate
  10. by UUCP.  The primary purpose is to document possible routes for
  11. mail.  When the "pathalias" program is run on the UUCP map data, it
  12. outputs the most efficient path from a specified host (usually your
  13. own) to all other hosts listed in the map.  Most ``smart'' mail
  14. programs on the UUCP network can use the pathalias output to route mail
  15. without the user having to specify explicit routes.
  16.  
  17.  
  18. Registering your site
  19.  
  20. To register a site in the UUCP map, fill out an entry in the format
  21. described below, and mail it to the registry address.
  22.  
  23. Canadian sites should mail to
  24.  
  25.         utai!path
  26. or
  27.         path@cs.toronto.edu
  28.  
  29. or, if the time of first registration is critical to reserve a name, to
  30.  
  31.         rutgers!uucpmap
  32.  
  33. Do not send to both, as the only function of rutgers!uucpmap is to record
  34. your submission and retransmit it to utai!path.  If you wish to register
  35. your site as a subdomain under the Canadian top-level domain (.CA), please
  36. contact utai!registry or registry@cs.toronto.edu for information.
  37.  
  38.  
  39. Format of a map entry
  40. ---------------------
  41.  
  42. A generic UUCP map entry looks like:
  43.  
  44. #N    sitename[, sitenames, domains]
  45. #S    manufacturer machine model; [operating system & version]
  46. #O    organization name
  47. #C    contact person(s) name(s)
  48. #E    contact person(s) electronic mail address(es)
  49. #T    contact person(s) telephone number(s)
  50. #P    organization's address
  51. #L    latitude / longitude
  52. #R    optionally a one line remark
  53. #U    netnews neighbors separated by spaces [more than one such line
  54. #U    is ok if you have more neighbours than will fit on one line]
  55. #W    address of the person who last edited the entry ; date last edited
  56. #
  57. #    additional comments go here.  As many lines as you want.
  58. #    Equivalencing your site to a domain name is optional -- if
  59. #    you want to register a domain name, do so with the
  60. #    proper authorities running the domain in question.
  61. #
  62. sitename    .domain(LOCAL)
  63. sitename    remote1(FREQUENCY), remote2(FREQUENCY),
  64.         remote3(FREQUENCY)
  65.  
  66. The lines beginning with '#' are comments to pathalias, which will
  67. ignore them.  Lines beginning with '#' immediately followed by an
  68. upper case letter have specific formats and are used by other programs
  69. that process map data.  Lines beginning with '#' immediately followed
  70. by a space or tab are comments that are ignored.
  71.  
  72. The #[letter] must be followed by a TAB character (ASCII code 011
  73. octal, often represented as \t in C programs and some documents) -- do
  74. not use spaces instead.
  75.  
  76. Keep all lines to under 80 columns -- the maps have to be sent through
  77. machines that can be actively hostile to long lines.
  78.  
  79.  
  80. Examples of map entries:
  81.  
  82. [These examples were taken from the maps in October 1990.  They do
  83.  not reflect the current status of those sites]
  84.  
  85. The first example, for site "iceman", is a simple map entry -- it has
  86. a single UUCP connection to another site, "alberta".
  87.  
  88. #N    iceman
  89. #S    AT&T UNIX-pc 3B1; SYSV Rel. 2 Ver. 3.51
  90. #O    private site
  91. #C    Michel Adam
  92. #E    iceman!michel
  93. #T    +1 403 920 8792
  94. #P    301 Ptarmigan, 42 Con Rd., Yellowknife, N.W.T., Canada X1A 1X6
  95. #L    62 27 43 N / 114 26 04 W
  96. #R
  97. #U    
  98. #W    iceman!michel (Michel Adam); Wed Mar  7 00:31:25 MST 1990
  99. #
  100. iceman        alberta(DAILY)
  101.  
  102.  
  103. Site "tmsoft", the second example, is a slightly more complicated map
  104. entry.  It has a lot of UUCP feeds for both mail and news,
  105. more than one modem, and therefore prioritizes its links.
  106.  
  107. #N    tmsoft
  108. #S    National Semiconductor ICM3216; Unix System 5r2
  109. #O    TM Software Associates Inc., Toronto
  110. #C    Dave Mason
  111. #E    ryescs!mason, tmsoft!mason
  112. #T    +1 416 463 7095
  113. #P    92 Gough Ave, Toronto, Ontario, Canada M4K 3N8
  114. #L    79 23 15 W / 43 39 20 N
  115. #R    Compiler & Operating System Development
  116. #U    torsqnt mnetor beaudin itcyyz masnet yrloc becker telly
  117. #W    tmsoft!mason (Dave Mason); Wed Jul 11 19:18:31 EDT 1990
  118. #
  119. #    System Software development & Consulting, Teaching
  120. #
  121. #    We archive comp.sources.{unix,misc,x,games}
  122. #
  123. # in the following: WP - we poll, TP - they poll, BP - bidirectional poll
  124. #            LOW=1200bps, HIGH=19200bps Telebit
  125. tmsoft    attcan(DIRECT+HIGH),    # BP - mail
  126.     aucs(WEEKLY+LOW),    # WP - mail, news: atl,ns,hfx
  127.     becker(DIRECT+HIGH),    # BP - mail, news: inet,ut,uw,ddn,pubnet,biz
  128.     beaudin(DIRECT+HIGH),    # BP - mail, full news
  129.     compugen(DIRECT+HIGH),    # BP - mail
  130.     compus(DIRECT),        # BP - mail
  131.     eci386(DIRECT),        # BP - mail
  132.     gate(DIRECT),        # BP - mail
  133.     grandison(POLLED),    # TP - mail, some news
  134.     ipsax(HOURLY*2+HIGH),    # TP - mail
  135.     itcyyz(DIRECT+HIGH),    # BP - mail, full news
  136.     lsimages(POLLED),    # TP - mail, some news
  137.     lsuc(DIRECT+HIGH),    # BP - mail, news: ont,tor
  138.     magsta(DIRECT),        # WP - mail
  139.     masnet(POLLED),        # TP - mail, 1/2 news, CanConfMail
  140.     mnetor(DIRECT+FAST-1),    # BP - mail, full news bidirectional
  141.     moore(DIRECT+HIGH),    # WP - mail
  142.     ontmoh(DIRECT+HIGH),    # BP - mail, minimal news
  143.     psican(DIRECT),        # BP - mail
  144.     roboha(DIRECT),        # BP - mail, news: can,ont,tor
  145.     ryescs(DIRECT),        # TP - mail, most news (coming soon)
  146.     stjoes(DIRECT),        # WP - mail
  147.     teecs(DIRECT+HIGH),    # BP - mail
  148.     telly(DIRECT+HIGH),    # BP - mail, news: can,ont,tor
  149.     torsqnt(DIRECT+HIGH),    # BP - mail, full news bidirectional
  150.     utcsri(DIRECT+HIGH),    # WP - mail
  151.     utgpu(DIRECT+HIGH),    # WP - mail
  152.     utzoo(DIRECT+HIGH),    # BP - mail
  153.     yrloc(DIRECT+HIGH),    # TP - mail
  154.     yunexus(DIRECT+HIGH),    # WP - mail
  155.     yzrnur(POLLED),        # TP - mail
  156.     ziebmef(DIRECT)        # BP - mail back from the dead...?!?
  157.  
  158.  
  159. The third example is of a site that has associated domain names in
  160. different domains, several long distance feeds and connects via a Local
  161. Area Network to several other sites.  See the pathalias manual page
  162. for details about Local Area Networks.
  163.  
  164. #N    watmath
  165. #S    DEC VAX-11/785; 4.3 BSD UNIX
  166. #O    Math Faculty Computing Facility, University of Waterloo
  167. #C    Bill Ince
  168. #E    watmath!postmaster
  169. #T    +1 519 885 1211 x2721
  170. #P    200 University Avenue, Waterloo, Ontario, Canada N2L 3G1
  171. #L    43 28 N / 80 23 W city
  172. #R    Main U. of Waterloo mail/news/admin site
  173. #U    alberta att dalcs decvax focsys isishq iuvax
  174. #U    looking lsuc mks onfcanim ncrwat ria softart
  175. #U    ubc-cs utgpu uunet xenitec
  176. #W    watmath!gamiddleton (Guy Middleton); Wed Aug 22 19:43:05 EDT 1990
  177. #
  178. watmath    .uwaterloo.ca, .waterloo.edu
  179. watmath = watmath.uwaterloo.ca, watmath.waterloo.edu
  180. watmath = math.uwaterloo.ca, math.waterloo.edu
  181. watmath = uwaterloo.ca, waterloo.edu
  182. watmath
  183.  # Local phone calls
  184.     focsys(EVENING), isishq(EVENING), looking(HOURLY), mgvax(WEEKLY),
  185.     mks(HOURLY), ncrwat(EVENING), softart(EVENING), stoga(EVENING),
  186.     tslwat(EVENING), watcomsys(EVENING), watcsc(DIRECT), xenitec(EVENING),
  187.  # Ontario LD
  188.     lsuc(EVENING), utzoo(EVENING),
  189.  # Canada LD
  190.     onfcanim(EVENING),
  191.  # USA LD
  192.     decvax(DAILY), linus(DAILY+LOW), plus5(DAILY),
  193.  # Ontario Internet
  194.     ria(HOURLY), utai(HOURLY),
  195.  # Canada Internet
  196.     alberta(HOURLY), calgary(HOURLY), dalcs(HOURLY), <ubc-cs>(DEMAND),
  197.  # USA Internet 
  198.     <iuvax>(HOURLY), uunet(HOURLY/2),
  199.  # Logical U of Waterloo LAN, well-known nodes only
  200. WaterlooNet = {
  201.     watmath,
  202.     maytag,                # uucp hub
  203.     wataco,                # Arts computing
  204.     watacs, watlager, watmad, watimp,
  205.     watale,                # General engineering research
  206.     watbun,                # Software Development
  207.     watcgl,                # Computer Graphics R&D
  208.     watcsg, watbank,         # R&D
  209.     watdcs,                 # Academic computing
  210.     watdragon, watyew,        # AI
  211.     water,                # Research
  212.     watmsg,                # Research in distributed systems
  213.     watpix,                # Arts computing
  214.     watrose, watshine, orchid,    # Teaching
  215.     watsol,                # New OED
  216.     watstat,            # Statistics
  217.     watvlsi, ccng            # VLSI and CCNG depts.
  218.  }!(LOCAL)
  219.  
  220.  
  221. Note that a large site listing internal hosts like this is frowned on.
  222. In general, internal hosts should not be mentioned in the UUCP map unless
  223. they do not use an organizational domain name for outgoing mail.  Any host
  224. that gateways between the UUCP network at large, and your organization,
  225. should have its own UUCP map entry.
  226.  
  227.  
  228. Each field in the map entry is documented in detail in the README
  229. file posted periodically to comp.mail.maps.  The following
  230. notes are additional clarifications or suggestions.
  231.  
  232. The machine name must be unique within the first six characters.  It
  233. may only have lower case alphanumerics or hyphens in it.  You may not
  234. use a name that someone else has already registered with their map
  235. entry.
  236.  
  237. Check the present set of maps in comp.mail.maps for the current set of
  238. names in use (grep '^#N' u.* should find them all) Else ask your
  239. regional map coordinator.  [We hope to eventually have an automatic
  240. mail server in place for answering questions like "is name foobar taken?"]
  241.  
  242. Choose a name that you would like to stay with for a long while --
  243. changing the name of the machine people associate you with can be very
  244. inconvenient for your e-mail correspondents and for you.  Remember that
  245. people will use the name in conversation.
  246.  
  247. Some hints for choosing a machine name [adapted from the Internet
  248. RFC1178 by Don Libes]
  249.  
  250.     Don't overload other terms already in common use - it confuses people.
  251.     Don't choose a name after a project unique to that machine - the
  252.         machine may get used for another project.
  253.     Don't use your own name. -- it confuses people.
  254.     Avoid alternate spellings or hard-to-pronounce words. -- you'd be
  255.         surprised how much mail bounces because of such names.
  256.     Avoid names very similar to other names -- it confuses people.
  257.     Don't use antagonistic or otherwise embarrassing names.
  258.     Don't use digits at the beginning of the name - it confuses programs.
  259.     Don't use non-alphanumeric characters in a name - it confuses programs.
  260.     Use words/names that are rarely used - uniqueness is nice.
  261.     Use theme names - if you're naming more than one machine.
  262.     Use real words - people can remember and spell them easily.
  263.     There is always room for an exception.
  264.  
  265. Remember to provide a trailing semi-colon on the operating system
  266. field (#S) even if you do not provide an operating system.
  267.  
  268. In the telephone field (#T) do not put spaces between the 'x' and the
  269. extension number, if any.  Do not put dashes, parenthesis, or any
  270. other characters in the phone number.  The format is standard for
  271. international phone numbers, e.g., +1 800 555 1212.
  272.  
  273. Please do provide your latitude and longitude as accurately as you
  274. can.  It is useful for maps of the network, especially in cities with
  275. a lot of UUCP sites.
  276.  
  277. Remember to add your province in the address in the #P field.  The
  278. accepted two letter or three letter abbreviation is fine, or the full
  279. name. We sort map entries by province.
  280.  
  281. When you submit an updated map entry, remember to update the date on
  282. the #W field.  The preferred date format is the output of the Unix
  283. date(1) command.  Specifying the date in GMT is a good way to avoid
  284. ambiguity in time zone names.  (You can instead put your local time
  285. zone in a comment or remark, specifying how far ahead of behind GMT it
  286. is)
  287.  
  288. Pathalias can deal with mail routes specified with !, %, : and @ as
  289. routing characters.  However, UUCP maps entries must only use !  as a
  290. routing character.  This makes the output of pathalias unambiguous to
  291. all mailers.
  292.  
  293. ----
  294. Questions or comments about this document should also be directed at
  295. utai!path.  Please mention the Header below when sending a question or
  296. comment.
  297.  
  298. $Header: TUTORIAL,v 1.4 90/10/14 18:01:35 path Exp $
  299.  
  300.  
  301.